Update Helm install command for Envoy Gateway #7637
Conversation
Removed version specification from Helm install command. The generated version was "v0.0.0-latest"! Signed-off-by: Aurelie Vache <[email protected]>
|
Thanks @scraly! |
|
|
||
| ```shell | ||
| helm install eg oci://docker.io/envoyproxy/gateway-helm --version {{< helm-version >}} -n envoy-gateway-system --create-namespace | ||
| helm install eg oci://docker.io/envoyproxy/gateway-helm -n envoy-gateway-system --create-namespace |
There was a problem hiding this comment.
I don't think we need this. When navigating to versioned install docs you get an actual version vs v0.0.0-latest, e.g. https://gateway.envoyproxy.io/v1.6/install/install-helm/#install-with-helm.
There was a problem hiding this comment.
As n user I don't want to install 0.0.0-latest but instead the latest version, 1.6 for example
There was a problem hiding this comment.
So then shouldn't the user navigate to the v1.6 docs pages? Perhaps for the latest version docs we can instead use the latest version (e.g. 1.6) instead but we shouldn't just remove this flag entirely.
There was a problem hiding this comment.
I'm certainly not an expert on UX but just sharing that the current setup will already facilitate what you mention if you navigate to the versioned docs page instead of "latest".
There was a problem hiding this comment.
Just to understand correctly, so for you it's normal to ask the user to install the v0.0.0-latest instead of the latest version?
There was a problem hiding this comment.
yeah this is by design @scraly
if a user has intentionally navigated from https://gateway.envoyproxy.io to https://gateway.envoyproxy.io/latest/ they are attempting to access unreleased bleeding edge content, there's even a banner on this page
Notice:
This is the "latest" release of Envoy Gateway, which contains the most recent commits from the main branch.
This release might not be stable.
Please refer to the [/docs](https://gateway.envoyproxy.io/docs) documentation for the most current information.
There was a problem hiding this comment.
I'm saying that a user can get the behavior you're seeking by navigating to the versioned docs pages such as https://gateway.envoyproxy.io/v1.6/install/install-helm/#install-with-helm and it doesn't seem irregular that the /latest versioned docs would use something like v0.0.0-latest.
I'm open to a discussion of whether the /latest docs pages (e.g. https://gateway.envoyproxy.io/latest/install/install-helm/#install-with-helm) should also default to the most recent version (e.g. currently v1.6) but I think your change here would break the versioned docs pages in future releases so instead of removing should map helm-version for latest to the most recent version.
There was a problem hiding this comment.
CC @envoyproxy/gateway-maintainers should the /latest docs pages use v0.0.0-latest or the most recent release (e.g. currently v1.6) for general docs and install steps?
As for some examples:
- Istio omits the version flag entirely so if a user navigates to an older release version and runs the setup guide they would instead be installing the most recent release version. This seems like a poor UX to me.
- Karpenter maps latest to the most recent release version and then has a separate "preview" docs version page which is equivalent to EG's current "latest".
Personally, the karpenter model makes most sense to me and may fix understandable confusion for users like @scraly who logically think latest will map to the most recent release version.
Edit: missed Arko's comment and didn't realize we had the existing banner. That seems reasonable as well and should be sufficient here.
There was a problem hiding this comment.
I'm fine with setting it to the latest release, as only for helm install.
But if it is described with the notice, I think we can keep the old style, we could improve it by setting something like preview, git tag instead of v0.0.0-latest.
4 participants
What type of PR is this?
What this PR does / why we need it:
Removed version specification from Helm install command.
The generated version in the helm install command was "v0.0.0-latest"!